<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>Monitor xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/mbari/vcr/timer/Monitor.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * @(#)Monitor.java   2009.02.24 at 09:44:55 PST</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Copyright 2007 MBARI</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> *</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * <a href="http://www.gnu.org/copyleft/lesser.html" target="alexandria_uri">http://www.gnu.org/copyleft/lesser.html</a></em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="16" href="#16">16</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="17" href="#17">17</a>  <em class="jxr_comment"> */</em>
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">package</strong> org.mbari.vcr.timer;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.util.Timer;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.IVCR;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> org.mbari.vcr.VCRAdapter;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment">/**</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * A Monitor is a custom wrapper around a Timer and a TimerTask. This allows</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * for sceduling of repeated periodic requests such as requests for staus or</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * timecode form the VCR.</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> *</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * @author brian</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> */</em>
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/mbari/vcr/timer/Monitor.html">Monitor</a> {
<a name="37" href="#37">37</a>  
<a name="38" href="#38">38</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(Monitor.<strong class="jxr_keyword">class</strong>);
<a name="39" href="#39">39</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> intervalMin = 33;
<a name="40" href="#40">40</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">long</strong> interval = intervalMin;
<a name="41" href="#41">41</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name;
<a name="42" href="#42">42</a>      <strong class="jxr_keyword">private</strong> Timer timer;
<a name="43" href="#43">43</a>      <strong class="jxr_keyword">private</strong> <a href="../../../../org/mbari/vcr/timer/VCRTimerTask.html">VCRTimerTask</a> timerTask;
<a name="44" href="#44">44</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Class timerTaskClass;
<a name="45" href="#45">45</a>      <strong class="jxr_keyword">private</strong> <a href="../../../../org/mbari/vcr/IVCR.html">IVCR</a> vcr;
<a name="46" href="#46">46</a>  
<a name="47" href="#47">47</a>      <em class="jxr_javadoccomment">/**</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">     * Constructs ...</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">     *</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">     * @param timerTaskClass</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     * @param name</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     */</em>
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/timer/Monitor.html">Monitor</a>(<strong class="jxr_keyword">final</strong> Class timerTaskClass, <strong class="jxr_keyword">final</strong> String name) {
<a name="54" href="#54">54</a>          <strong class="jxr_keyword">this</strong>(timerTaskClass, name, <strong class="jxr_keyword">new</strong> <a href="../../../../org/mbari/vcr/VCRAdapter.html">VCRAdapter</a>());
<a name="55" href="#55">55</a>      }
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <em class="jxr_javadoccomment">/**</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     * Constructs ...</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     *</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     * @param timerTaskClass</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     * @param name</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     * @param vcr</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     */</em>
<a name="64" href="#64">64</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/timer/Monitor.html">Monitor</a>(<strong class="jxr_keyword">final</strong> Class timerTaskClass, <strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> <a href="../../../../org/mbari/vcr/IVCR.html">IVCR</a> vcr) {
<a name="65" href="#65">65</a>          <strong class="jxr_keyword">this</strong>.name = name;
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">this</strong>.timerTaskClass = timerTaskClass;
<a name="67" href="#67">67</a>          setVcr(vcr);
<a name="68" href="#68">68</a>          log.debug(<span class="jxr_string">"Initialized Monitor '"</span> + name + <span class="jxr_string">"'"</span>);
<a name="69" href="#69">69</a>      }
<a name="70" href="#70">70</a>  
<a name="71" href="#71">71</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getInterval() {
<a name="72" href="#72">72</a>          <strong class="jxr_keyword">return</strong> interval;
<a name="73" href="#73">73</a>      }
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getIntervalMin() {
<a name="76" href="#76">76</a>          <strong class="jxr_keyword">return</strong> intervalMin;
<a name="77" href="#77">77</a>      }
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <strong class="jxr_keyword">public</strong> String getName() {
<a name="80" href="#80">80</a>          <strong class="jxr_keyword">return</strong> name;
<a name="81" href="#81">81</a>      }
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/timer/VCRTimerTask.html">VCRTimerTask</a> getTimerTask() {
<a name="84" href="#84">84</a>          <strong class="jxr_keyword">boolean</strong> isRunning = (timer != <strong class="jxr_keyword">null</strong>);
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>          <strong class="jxr_keyword">if</strong> (!isRunning) {
<a name="87" href="#87">87</a>              <strong class="jxr_keyword">try</strong> {
<a name="88" href="#88">88</a>                  timerTask = (VCRTimerTask) timerTaskClass.newInstance();
<a name="89" href="#89">89</a>                  timerTask.setVcr(vcr);
<a name="90" href="#90">90</a>              }
<a name="91" href="#91">91</a>              <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a name="92" href="#92">92</a>                  log.error(<span class="jxr_string">"Unable to instantiate "</span> + timerTaskClass, ex);
<a name="93" href="#93">93</a>              }
<a name="94" href="#94">94</a>          }
<a name="95" href="#95">95</a>  
<a name="96" href="#96">96</a>          <strong class="jxr_keyword">return</strong> timerTask;
<a name="97" href="#97">97</a>      }
<a name="98" href="#98">98</a>  
<a name="99" href="#99">99</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../org/mbari/vcr/IVCR.html">IVCR</a> getVcr() {
<a name="100" href="#100">100</a>         <strong class="jxr_keyword">return</strong> vcr;
<a name="101" href="#101">101</a>     }
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setInterval(<strong class="jxr_keyword">long</strong> interval) {
<a name="104" href="#104">104</a>         <strong class="jxr_keyword">if</strong> (interval &lt; intervalMin) {
<a name="105" href="#105">105</a>             interval = intervalMin;
<a name="106" href="#106">106</a>         }
<a name="107" href="#107">107</a> 
<a name="108" href="#108">108</a>         <strong class="jxr_keyword">boolean</strong> reset = interval != <strong class="jxr_keyword">this</strong>.interval;
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>         <strong class="jxr_keyword">this</strong>.interval = interval;
<a name="111" href="#111">111</a> 
<a name="112" href="#112">112</a>         <strong class="jxr_keyword">if</strong> (reset &amp;&amp; (timer != <strong class="jxr_keyword">null</strong>)) {
<a name="113" href="#113">113</a>             stop();
<a name="114" href="#114">114</a>             start();
<a name="115" href="#115">115</a>         }
<a name="116" href="#116">116</a>     }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setIntervalMin(<strong class="jxr_keyword">long</strong> intervalMin) {
<a name="119" href="#119">119</a>         <strong class="jxr_keyword">this</strong>.intervalMin = intervalMin;
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>         <strong class="jxr_keyword">if</strong> (interval &lt; intervalMin) {
<a name="122" href="#122">122</a>             setInterval(intervalMin);
<a name="123" href="#123">123</a>         }
<a name="124" href="#124">124</a>     }
<a name="125" href="#125">125</a> 
<a name="126" href="#126">126</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> setVcr(<a href="../../../../org/mbari/vcr/IVCR.html">IVCR</a> vcr) {
<a name="127" href="#127">127</a> 
<a name="128" href="#128">128</a>         <strong class="jxr_keyword">boolean</strong> isRunning = (timer != <strong class="jxr_keyword">null</strong>);
<a name="129" href="#129">129</a> 
<a name="130" href="#130">130</a>         <em class="jxr_comment">// Turn off the timer if it's running</em>
<a name="131" href="#131">131</a>         <strong class="jxr_keyword">if</strong> (isRunning) {
<a name="132" href="#132">132</a>             stop();
<a name="133" href="#133">133</a>         }
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>         <strong class="jxr_keyword">this</strong>.vcr = vcr;
<a name="136" href="#136">136</a> 
<a name="137" href="#137">137</a>         <em class="jxr_comment">// Restart timer if it was running</em>
<a name="138" href="#138">138</a>         <strong class="jxr_keyword">if</strong> (isRunning) {
<a name="139" href="#139">139</a>             start();
<a name="140" href="#140">140</a>         }
<a name="141" href="#141">141</a>     }
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> start() {
<a name="144" href="#144">144</a>         <strong class="jxr_keyword">if</strong> (timer == <strong class="jxr_keyword">null</strong>) {
<a name="145" href="#145">145</a>             <strong class="jxr_keyword">final</strong> String threadName = (name == <strong class="jxr_keyword">null</strong>)
<a name="146" href="#146">146</a>                                       ? <span class="jxr_string">"Monitor-"</span> + System.currentTimeMillis()
<a name="147" href="#147">147</a>                                       : name + <span class="jxr_string">"-"</span> + System.currentTimeMillis();
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>             log.debug(<span class="jxr_string">"Starting "</span> + threadName);
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>             <em class="jxr_comment">// Must get the task BEFORE we intialize the timer here.</em>
<a name="152" href="#152">152</a>             <a href="../../../../org/mbari/vcr/timer/VCRTimerTask.html">VCRTimerTask</a> task = getTimerTask();
<a name="153" href="#153">153</a> 
<a name="154" href="#154">154</a>             timer = <strong class="jxr_keyword">new</strong> Timer(threadName, <strong class="jxr_keyword">true</strong>);
<a name="155" href="#155">155</a>             timer.schedule(task, 0, getInterval());
<a name="156" href="#156">156</a>         }
<a name="157" href="#157">157</a>     }
<a name="158" href="#158">158</a> 
<a name="159" href="#159">159</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> stop() {
<a name="160" href="#160">160</a>         <strong class="jxr_keyword">if</strong> (timer != <strong class="jxr_keyword">null</strong>) {
<a name="161" href="#161">161</a>             log.debug(<span class="jxr_string">"Stopping "</span> + name);
<a name="162" href="#162">162</a>             timer.cancel();
<a name="163" href="#163">163</a>             timer = <strong class="jxr_keyword">null</strong>;
<a name="164" href="#164">164</a>         }
<a name="165" href="#165">165</a>     }
<a name="166" href="#166">166</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

